mcp
`POST /api/mcp/connectors` — register a custom MCP connector (owned by caller).
POST
/
api
/
mcp
/
connectors
`POST /api/mcp/connectors` — register a custom MCP connector (owned by caller).
curl --request POST \
--url https://api.example.com/api/mcp/connectors \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"auth_type": "<string>",
"basic_password": "<string>",
"basic_username": "<string>",
"credential_header_name": "<string>",
"description": "<string>",
"display_name": "<string>",
"headers": {},
"logo_url": "<string>",
"oauth_client_id": "<string>",
"oauth_client_secret": "<string>",
"transport": "<string>",
"url_param_name": "<string>"
}
'import requests
url = "https://api.example.com/api/mcp/connectors"
payload = {
"name": "<string>",
"url": "<string>",
"auth_type": "<string>",
"basic_password": "<string>",
"basic_username": "<string>",
"credential_header_name": "<string>",
"description": "<string>",
"display_name": "<string>",
"headers": {},
"logo_url": "<string>",
"oauth_client_id": "<string>",
"oauth_client_secret": "<string>",
"transport": "<string>",
"url_param_name": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
auth_type: '<string>',
basic_password: '<string>',
basic_username: '<string>',
credential_header_name: '<string>',
description: '<string>',
display_name: '<string>',
headers: {},
logo_url: '<string>',
oauth_client_id: '<string>',
oauth_client_secret: '<string>',
transport: '<string>',
url_param_name: '<string>'
})
};
fetch('https://api.example.com/api/mcp/connectors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/mcp/connectors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'url' => '<string>',
'auth_type' => '<string>',
'basic_password' => '<string>',
'basic_username' => '<string>',
'credential_header_name' => '<string>',
'description' => '<string>',
'display_name' => '<string>',
'headers' => [
],
'logo_url' => '<string>',
'oauth_client_id' => '<string>',
'oauth_client_secret' => '<string>',
'transport' => '<string>',
'url_param_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/mcp/connectors"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"basic_password\": \"<string>\",\n \"basic_username\": \"<string>\",\n \"credential_header_name\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"headers\": {},\n \"logo_url\": \"<string>\",\n \"oauth_client_id\": \"<string>\",\n \"oauth_client_secret\": \"<string>\",\n \"transport\": \"<string>\",\n \"url_param_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/mcp/connectors")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"basic_password\": \"<string>\",\n \"basic_username\": \"<string>\",\n \"credential_header_name\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"headers\": {},\n \"logo_url\": \"<string>\",\n \"oauth_client_id\": \"<string>\",\n \"oauth_client_secret\": \"<string>\",\n \"transport\": \"<string>\",\n \"url_param_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/mcp/connectors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"basic_password\": \"<string>\",\n \"basic_username\": \"<string>\",\n \"credential_header_name\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"headers\": {},\n \"logo_url\": \"<string>\",\n \"oauth_client_id\": \"<string>\",\n \"oauth_client_secret\": \"<string>\",\n \"transport\": \"<string>\",\n \"url_param_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"message": "<string>",
"status_code": 200
}{
"data": {},
"message": "<string>",
"status_code": 200
}Body
application/json
Show child attributes
Show child attributes
Response
Connector created — data is the connector view
Doc-only schema for the standard MCP ApiResponse envelope
({"data": …, "status_code": N, "message": "…"}). Most /api/mcp/*
payloads are service-layer serde_json::Value views, so data is
documented as a free-form object; each route's response description says
what it carries.
⌘I
`POST /api/mcp/connectors` — register a custom MCP connector (owned by caller).
curl --request POST \
--url https://api.example.com/api/mcp/connectors \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"auth_type": "<string>",
"basic_password": "<string>",
"basic_username": "<string>",
"credential_header_name": "<string>",
"description": "<string>",
"display_name": "<string>",
"headers": {},
"logo_url": "<string>",
"oauth_client_id": "<string>",
"oauth_client_secret": "<string>",
"transport": "<string>",
"url_param_name": "<string>"
}
'import requests
url = "https://api.example.com/api/mcp/connectors"
payload = {
"name": "<string>",
"url": "<string>",
"auth_type": "<string>",
"basic_password": "<string>",
"basic_username": "<string>",
"credential_header_name": "<string>",
"description": "<string>",
"display_name": "<string>",
"headers": {},
"logo_url": "<string>",
"oauth_client_id": "<string>",
"oauth_client_secret": "<string>",
"transport": "<string>",
"url_param_name": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
auth_type: '<string>',
basic_password: '<string>',
basic_username: '<string>',
credential_header_name: '<string>',
description: '<string>',
display_name: '<string>',
headers: {},
logo_url: '<string>',
oauth_client_id: '<string>',
oauth_client_secret: '<string>',
transport: '<string>',
url_param_name: '<string>'
})
};
fetch('https://api.example.com/api/mcp/connectors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/mcp/connectors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'url' => '<string>',
'auth_type' => '<string>',
'basic_password' => '<string>',
'basic_username' => '<string>',
'credential_header_name' => '<string>',
'description' => '<string>',
'display_name' => '<string>',
'headers' => [
],
'logo_url' => '<string>',
'oauth_client_id' => '<string>',
'oauth_client_secret' => '<string>',
'transport' => '<string>',
'url_param_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/mcp/connectors"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"basic_password\": \"<string>\",\n \"basic_username\": \"<string>\",\n \"credential_header_name\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"headers\": {},\n \"logo_url\": \"<string>\",\n \"oauth_client_id\": \"<string>\",\n \"oauth_client_secret\": \"<string>\",\n \"transport\": \"<string>\",\n \"url_param_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/mcp/connectors")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"basic_password\": \"<string>\",\n \"basic_username\": \"<string>\",\n \"credential_header_name\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"headers\": {},\n \"logo_url\": \"<string>\",\n \"oauth_client_id\": \"<string>\",\n \"oauth_client_secret\": \"<string>\",\n \"transport\": \"<string>\",\n \"url_param_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/mcp/connectors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"auth_type\": \"<string>\",\n \"basic_password\": \"<string>\",\n \"basic_username\": \"<string>\",\n \"credential_header_name\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"headers\": {},\n \"logo_url\": \"<string>\",\n \"oauth_client_id\": \"<string>\",\n \"oauth_client_secret\": \"<string>\",\n \"transport\": \"<string>\",\n \"url_param_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"message": "<string>",
"status_code": 200
}{
"data": {},
"message": "<string>",
"status_code": 200
}